home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 February: Technology Seed / Mac Tech Seed Feb '97.toast / OpenDoc 1.2b2c1 / OpenDoc / Interfaces / Handmade / ShPlugIn.h < prev   
Encoding:
C/C++ Source or Header  |  1997-02-13  |  1.6 KB  |  62 lines  |  [TEXT/MPS ]
  1. /*
  2.     File:        ShPlugIn.h
  3.  
  4.     Contains:    Interface and constants for ShellPlugin Shared Libraries
  5.  
  6.     Owned by: Eric House
  7.  
  8.     Copyright:    © 1993 - 1995 by Apple Computer, Inc., all rights reserved.
  9.  
  10.     Change History (most recent first):
  11.  
  12.          <5>     9/27/95    eeh        1284893: fix capitalization
  13.          <4>     9/26/95    eeh        1284893: remove macros, fix
  14.                                     kODShellPluginCloseConnection
  15.          <3>     9/19/95    eeh        1284893: add kODShellPluginCloseConnection
  16.                                     etc.
  17.          <2>     9/12/95    eeh        1253309: make ODShellPluginInstallProc
  18.                                     extern 'C'
  19.          <1>     9/11/95    eeh        first checked in
  20.  
  21.     To Do:
  22.     In Progress:
  23.         
  24. */
  25.  
  26. #ifndef _SHPLUGIN_
  27. #define _SHPLUGIN_
  28.  
  29. typedef ODULong ODShellPlugInActionCodes;
  30.  
  31. // action codes.  ODShellPlugInActionCodes is a bit vector.
  32. // Now there is but one action to be turned
  33. // on or off: kODShellPlugInCloseConnection, which asks the Shell to
  34. // close the connection that was opened in order to call the 
  35. // ODShellPlugInInstallProc.  Later we'll add up to 31 others, among
  36. // which kODShellPlugInCallOnShutdown is an obvious candidate.
  37.  
  38. #define kODShellPlugInCloseConnection        1<<0
  39. // others to follow (next is 1<<1, then 1<<2, etc.)
  40.  
  41. // kODShellPlugInNoAction is the value to which action is initalized
  42. // before the ODShellPlugInInstall proc is called.  Clients need only
  43. // set those bits corresponding to actions they want taken on return.
  44. // Leaving them cleared gets them the default behavior: no action.
  45.  
  46. #define kODShellPlugInNoAction        0x00000000
  47.  
  48. #ifdef __cplusplus
  49. extern "C" {
  50. #endif
  51.  
  52. class Environment;
  53. class ODDraft;
  54.  
  55. typedef OSErr (*ODShellPlugInInstallProc)( Environment*,
  56.         ODDraft*, ODShellPlugInActionCodes* );
  57.  
  58. #ifdef __cplusplus
  59. }
  60. #endif
  61.  
  62. #endif